Skip to main content
`Ctrl`+`K`

# ng911ok.lib.comparison module

exception FeatureClassNotFoundError(session: NG911Session, feature_class: NG911FeatureClass)

  Bases: `OSError`

  property path: Path

class NG911GeodatabaseComparator(gdb1: NG911Session, gdb2: NG911Session)
class NG911GeodatabaseComparator(gdb1: PathLike[str] | str, gdb2: PathLike[str] | str, respect_submit: bool)

  Bases: `object`

  static _get_comparison_df(feature_class: NG911FeatureClass, fc1: str, fc2: str, csv_destination: Path) → DataFrame
  compare_feature_class(feature_class: NG911FeatureClass, output_location: Path, output_name: str) → tuple[DataFrame, Path]
  compare_feature_class(feature_class: NG911FeatureClass) → DataFrame
  compare_geodatabases(export: bool = False) → DataFrame

    Compares the NG911 feature classes of the comparator’s two geodatabases. Optionally exports a table of differences (named “ComparisonResults”) to the first geodatabase.

    Columns in the output data frame (and optional table) include:

    - `Identifier` - The type of difference

    - `Message` - Prose description of the difference

    - `Base_value` - The value in GDB #1

    - `Test_value` - The value in GDB #2

    - `Layer` - The name of the feature class containing the difference

    - `Field` - The name of the field containing the difference

    Parameters:

      export (bool) – Whether to export a table of differences to the first geodatabase, default False

    Returns:

      Tabular representation (data frame) of the differences

    Return type:

      pandas.DataFrame

  gdb1: NG911Session
  gdb2: NG911Session

class _GDBDiffRecordDict

  Bases: `TypedDict`

  Base_value: str | int | float | bool
  Identifier: str
  Message: str
  Test_value: str | int | float | bool